/* Copyright (c) 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.orkut.client.api.samples.greetings.client.services;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
import com.google.orkut.client.api.samples.greetings.shared.AuthorizationException;

import java.util.ArrayList;

/**
 * A service which serves user related requests.
 *
 * @author Shishir Birmiwal
 */
@RemoteServiceRelativePath("user")
public interface UserService extends RemoteService {
  /**
   * Gets information about the logged in user.
   *
   * @param postToken
   * @return information about the user
   */
  UserInfo getLoggedInUserInfo(String postToken) throws AuthorizationException;

  /**
   * Gets information about a given user.
   *
   * @param postToken session token
   * @param userId the user-id to get info for
   * @return information about the requested user
   */
  UserInfo getUserInfo(String postToken, String userId) throws AuthorizationException;

  /**
   * Returns the list of friends of a user.
   *
   * @param postToken session token
   * @param userId the user-id to get friends of
   * @return list of friends
   */
  ArrayList<UserInfo> getFriendsOf(String postToken, String userId) throws AuthorizationException;

  /**
   * Sends a scrap to a user with a photo and a message.
   *
   * @param postToken
   * @param toUserId
   * @param photo
   * @param msg
   * @return <code>true</code> iff scrap was successful
   */
  CaptchaInfo scrapUser(String postToken, ArrayList<String> toUserIds,
      PhotoInfo photo, boolean useSmallerImage, boolean postUpdate,
      String msg, String captchaToken, String captchaAnswer) throws AuthorizationException;

  /**
   * Logs the logged in user out and returns true when successful.
   *
   * @param postToken the session token
   * @return <code>true</code> if the user was logged out successfully
   */
  boolean logoutUser(String postToken) throws AuthorizationException;
}
